Empaquetage d’une Application

Pour distribuer votre application avec Electron, vous devez l’empaqueter et la rebaptiser. Pour ce faire, vous pouvez soit utiliser des outils spécialisés , soit le faire manuellement.

Avec des Outils

Il existe un certain nombre d'outils pour empaqueter et distribuer votre application Electron. Nous vous recommandons d’utiliser Electron Forge . Vous pouvez consulter sa documentation, ou vous reporter à la section Empaqueter votre application du tutoriel Electron.

Empaquetage manuel

Dans le cas où vous préférez cette approche, il y a 2 façons de distribuer votre application :

• Avec des binaires précompilés
• Avec une archive du code source de l'application

Avec des binaires précompilés

Pour distribuer votre application manuellement, vous devez télécharger les binaires précompilés d'Electron. Ensuite, le dossier contenant votre application devra être nommé app et placé dans le répertoire de ressources d'Electron, comme illustré dans les exemples suivants.

note

L’emplacement des binaires prédéfinis d’Electron est indiqué avec electron/ dans les exemples ci-dessous.

macOS

electron/Electron.app/Contents/Resources/app/
├── package.json
├── main.js
└── index.html

Windows and Linux

electron/resources/app
├── package.json
├── main.js
└── index.html

Exécutez ensuite Electron.app sous macOS, electron sous Linux ou electron.exe sous Windows, et Electron démarrera en tant qu'application. Le répertoire electron contiendra alors la distribution à livrer aux utilisateurs.

Avec une archive de code source de l'application (asar)

Au lieu de distribuer votre application en copiant tous ses fichiers sources, vous pouvez empaqueter votre application dans une archive asar pour améliorer les performances de lecture des fichiers sur des plateformes telles que Windows, si vous n’utilisez pas déjà un bundler tel que Parcel ou Webpack.

Pour utiliser une archive asar au lieu du dossier app, vous devez renommer l'archive en app.asar et la placer dans le dossier ressources d'Electron comme ci-dessous. Ainsi, Electron essaiera de lire l'archive et de se lancer à partir de celle-ci.

macOS

electron/Electron.app/Contents/Resources/
└── app.asar

Windows

electron/resources/
└── app.asar

Vous pouvez trouver plus de détails sur l'utilisation de asar dans le dépôt electron/asar sur github.

Renommer avec les binaires téléchargés

Après avoir empaqueté votre application dans Electron, vous voudrez bien sur renommer votre application avant de la distribuer aux utilisateurs.

• Windows: Vous pouvez renommer electron.exe à comme vous le souhaiter et modifier son icône et d’autres informations avec des outils comme rcedit.

• Linux: Vous pouvez renommer l’exécutable electron avec le nom de votre choix.

• macOS : Vous pouvez renommer Electron.app comme vous le souhaitez, et vous devez également renommer les champs CFBundleDisplayName, CFBundleIdentifier et CFBundleName dans les fichiers suivants :

  • Electron.app/Contents/Info.plist
  • Electron.app/Contents/Frameworks/Electron Helper.app/Contents/Info.plist

  Vous pouvez aussi renommer l'application d'aide pour éviter d'afficher Electron Helper dans le moniteur d'activité, mais assurez vous d'avoir renommé le nom du fichier exécutable de l'application d'aide.

  La structure d'une application renommée se présentera ainsi :

MyApp.app/Contents
├── Info.plist
├── MacOS/
│   └── MyApp
└── Frameworks/
    └── MyApp Helper.app
        ├── Info.plist
        └── MacOS/
            └── MyApp Helper

note

il est aussi possible de renommer Electron par le nom du produit et le compiler depuis le code source. Pour faire cela, vous devez définir les arguments de compilation correspondant au nom du produit (electron_product_name = "LeNomDeVotreProduit") dans le fichier args.gn et recompiler.

Notez bien toutefois que cela n’est pas recommandé car la configuration de l’environnement pour compiler à partir des sources n’est pas triviale et prend beaucoup de temps.